<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hardware Abstraction Layer (HAL)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Hardware Abstraction Layer (HAL)</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__group__hal__general__types.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#groups">API Reference</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle"><div class="title">General Types<div class="ingroups"><a class="el" href="group__group__hal__types.html">HAL General Types/Macros</a></div></div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p >This section documents the basic types that are used by multiple HAL drivers. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
API Reference</h2></td></tr>
<tr class="memitem:group__group__hal__results"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__results.html">Result Codes</a></td></tr>
<tr class="memdesc:group__group__hal__results"><td class="mdescLeft">&#160;</td><td class="mdescRight">HAL specific return codes definitions for all drivers. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__syspm"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__syspm.html">System Power Management</a></td></tr>
<tr class="memdesc:group__group__hal__syspm"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface for changing power states and restricting when they are allowed. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__clock"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__clock.html">Clock</a></td></tr>
<tr class="memdesc:group__group__hal__clock"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface for getting and changing clock configuration. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gab2d2acfb82599df54152be0b170c6ec2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__general__types.html#gab2d2acfb82599df54152be0b170c6ec2">cyhal_async_mode_t</a> { <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#ggab2d2acfb82599df54152be0b170c6ec2a580896db2028c77f9f89cb8772a1eb90">CYHAL_ASYNC_DMA</a>
, <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#ggab2d2acfb82599df54152be0b170c6ec2ad748e5570bc89fd722da9720b3d22a19">CYHAL_ASYNC_SW</a>
<br />
 }</td></tr>
<tr class="memdesc:gab2d2acfb82599df54152be0b170c6ec2"><td class="mdescLeft">&#160;</td><td class="mdescRight">group_hal_results  <a href="group__group__hal__general__types.html#gab2d2acfb82599df54152be0b170c6ec2">More...</a><br /></td></tr>
<tr class="separator:gab2d2acfb82599df54152be0b170c6ec2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga48a2f3a7a4210f50859fc68fa3db9391"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__general__types.html#ga48a2f3a7a4210f50859fc68fa3db9391">cyhal_edge_type_t</a> { <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#gga48a2f3a7a4210f50859fc68fa3db9391a8b48d6db40d0ad94cfd258238350e1d5">CYHAL_EDGE_TYPE_RISING_EDGE</a>
, <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#gga48a2f3a7a4210f50859fc68fa3db9391aea75bc3e36a1650159473acacc0af253">CYHAL_EDGE_TYPE_FALLING_EDGE</a>
, <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#gga48a2f3a7a4210f50859fc68fa3db9391a23f061bbf384f03c4c2ea375e99a8910">CYHAL_EDGE_TYPE_BOTH_EDGES</a>
, <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#gga48a2f3a7a4210f50859fc68fa3db9391aa3d90da24e0ba6dff6a0f4c816d1853b">CYHAL_EDGE_TYPE_LEVEL</a>
<br />
 }</td></tr>
<tr class="memdesc:ga48a2f3a7a4210f50859fc68fa3db9391"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enum of signal edge types.  <a href="group__group__hal__general__types.html#ga48a2f3a7a4210f50859fc68fa3db9391">More...</a><br /></td></tr>
<tr class="separator:ga48a2f3a7a4210f50859fc68fa3db9391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga246fde0e79029f514ce3846b31e366d7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__general__types.html#ga246fde0e79029f514ce3846b31e366d7">cyhal_power_level_t</a> { <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#gga246fde0e79029f514ce3846b31e366d7a0f601c5d5843c59e58ee1988dd0e6861">CYHAL_POWER_LEVEL_OFF</a>
, <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#gga246fde0e79029f514ce3846b31e366d7ae06723d07ff431a2f427d95ac61e2afb">CYHAL_POWER_LEVEL_LOW</a>
, <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#gga246fde0e79029f514ce3846b31e366d7ae189a666d589f8acf4c64142365def61">CYHAL_POWER_LEVEL_MEDIUM</a>
, <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#gga246fde0e79029f514ce3846b31e366d7a4d8ce140c28177e31de20cf8da8e2a99">CYHAL_POWER_LEVEL_HIGH</a>
, <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#gga246fde0e79029f514ce3846b31e366d7a6f0f4df45e9cac012a2c8e5ba736241b">CYHAL_POWER_LEVEL_DEFAULT</a>
<br />
 }</td></tr>
<tr class="memdesc:ga246fde0e79029f514ce3846b31e366d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selectable power levels.  <a href="group__group__hal__general__types.html#ga246fde0e79029f514ce3846b31e366d7">More...</a><br /></td></tr>
<tr class="separator:ga246fde0e79029f514ce3846b31e366d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga801c21c8f1d529c8d189990ce6825080"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__general__types.html#ga801c21c8f1d529c8d189990ce6825080">cyhal_signal_type_t</a> { <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#gga801c21c8f1d529c8d189990ce6825080aa9353d53eb66a3c2e9ebdddf5d0a2592">CYHAL_SIGNAL_TYPE_LEVEL</a> = 0
, <br />
&#160;&#160;<a class="el" href="group__group__hal__general__types.html#gga801c21c8f1d529c8d189990ce6825080a58d09b40c703bb1d09ac9d635c096cd9">CYHAL_SIGNAL_TYPE_EDGE</a> = 1
<br />
 }</td></tr>
<tr class="memdesc:ga801c21c8f1d529c8d189990ce6825080"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal trigger type.  <a href="group__group__hal__general__types.html#ga801c21c8f1d529c8d189990ce6825080">More...</a><br /></td></tr>
<tr class="separator:ga801c21c8f1d529c8d189990ce6825080"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gab2d2acfb82599df54152be0b170c6ec2" name="gab2d2acfb82599df54152be0b170c6ec2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab2d2acfb82599df54152be0b170c6ec2">&#9670;&nbsp;</a></span>cyhal_async_mode_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__hal__general__types.html#gab2d2acfb82599df54152be0b170c6ec2">cyhal_async_mode_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>group_hal_results </p>
<p >Modes that can be used for asynchronous transfers </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggab2d2acfb82599df54152be0b170c6ec2a580896db2028c77f9f89cb8772a1eb90" name="ggab2d2acfb82599df54152be0b170c6ec2a580896db2028c77f9f89cb8772a1eb90"></a>CYHAL_ASYNC_DMA&#160;</td><td class="fielddoc"><p >Use DMA if available. </p>
<p >Otherwise fall back to software transfer. (Default) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggab2d2acfb82599df54152be0b170c6ec2ad748e5570bc89fd722da9720b3d22a19" name="ggab2d2acfb82599df54152be0b170c6ec2ad748e5570bc89fd722da9720b3d22a19"></a>CYHAL_ASYNC_SW&#160;</td><td class="fielddoc"><p >Always perform a software transfer. </p>
</td></tr>
</table>

</div>
</div>
<a id="ga48a2f3a7a4210f50859fc68fa3db9391" name="ga48a2f3a7a4210f50859fc68fa3db9391"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga48a2f3a7a4210f50859fc68fa3db9391">&#9670;&nbsp;</a></span>cyhal_edge_type_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__hal__general__types.html#ga48a2f3a7a4210f50859fc68fa3db9391">cyhal_edge_type_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enum of signal edge types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga48a2f3a7a4210f50859fc68fa3db9391a8b48d6db40d0ad94cfd258238350e1d5" name="gga48a2f3a7a4210f50859fc68fa3db9391a8b48d6db40d0ad94cfd258238350e1d5"></a>CYHAL_EDGE_TYPE_RISING_EDGE&#160;</td><td class="fielddoc"><p >Rising edge. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga48a2f3a7a4210f50859fc68fa3db9391aea75bc3e36a1650159473acacc0af253" name="gga48a2f3a7a4210f50859fc68fa3db9391aea75bc3e36a1650159473acacc0af253"></a>CYHAL_EDGE_TYPE_FALLING_EDGE&#160;</td><td class="fielddoc"><p >Falling edge. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga48a2f3a7a4210f50859fc68fa3db9391a23f061bbf384f03c4c2ea375e99a8910" name="gga48a2f3a7a4210f50859fc68fa3db9391a23f061bbf384f03c4c2ea375e99a8910"></a>CYHAL_EDGE_TYPE_BOTH_EDGES&#160;</td><td class="fielddoc"><p >Both edges. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga48a2f3a7a4210f50859fc68fa3db9391aa3d90da24e0ba6dff6a0f4c816d1853b" name="gga48a2f3a7a4210f50859fc68fa3db9391aa3d90da24e0ba6dff6a0f4c816d1853b"></a>CYHAL_EDGE_TYPE_LEVEL&#160;</td><td class="fielddoc"><p >Level. </p>
</td></tr>
</table>

</div>
</div>
<a id="ga246fde0e79029f514ce3846b31e366d7" name="ga246fde0e79029f514ce3846b31e366d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga246fde0e79029f514ce3846b31e366d7">&#9670;&nbsp;</a></span>cyhal_power_level_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__hal__general__types.html#ga246fde0e79029f514ce3846b31e366d7">cyhal_power_level_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Selectable power levels. </p>
<p >Power levels are defined relative to others. Higher power levels offer better performance but consume more power.</p>
<p >Not all hardware supports four discrete power levels. If fewer power levels are supported, the values will be mapped as follows: </p><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">4 Levels   </th><th class="markdownTableHeadNone">3 Levels   </th><th class="markdownTableHeadNone">2 Levels    </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Off   </td><td class="markdownTableBodyNone">Off   </td><td class="markdownTableBodyNone">Off    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">Low   </td><td class="markdownTableBodyNone">Low = Medium   </td><td class="markdownTableBodyNone">Low = Medium = High = Default    </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Medium   </td><td class="markdownTableBodyNone">High = Default   </td><td class="markdownTableBodyNone"></td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">High = Default   </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"></td></tr>
</table>
<p>See the implementation specific documentation for details. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga246fde0e79029f514ce3846b31e366d7a0f601c5d5843c59e58ee1988dd0e6861" name="gga246fde0e79029f514ce3846b31e366d7a0f601c5d5843c59e58ee1988dd0e6861"></a>CYHAL_POWER_LEVEL_OFF&#160;</td><td class="fielddoc"><p >Power-off the comparator, while retaining configuration. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga246fde0e79029f514ce3846b31e366d7ae06723d07ff431a2f427d95ac61e2afb" name="gga246fde0e79029f514ce3846b31e366d7ae06723d07ff431a2f427d95ac61e2afb"></a>CYHAL_POWER_LEVEL_LOW&#160;</td><td class="fielddoc"><p >Low comparator power and speed. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga246fde0e79029f514ce3846b31e366d7ae189a666d589f8acf4c64142365def61" name="gga246fde0e79029f514ce3846b31e366d7ae189a666d589f8acf4c64142365def61"></a>CYHAL_POWER_LEVEL_MEDIUM&#160;</td><td class="fielddoc"><p >Medium comparator power and speed. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga246fde0e79029f514ce3846b31e366d7a4d8ce140c28177e31de20cf8da8e2a99" name="gga246fde0e79029f514ce3846b31e366d7a4d8ce140c28177e31de20cf8da8e2a99"></a>CYHAL_POWER_LEVEL_HIGH&#160;</td><td class="fielddoc"><p >High comparator power and speed. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga246fde0e79029f514ce3846b31e366d7a6f0f4df45e9cac012a2c8e5ba736241b" name="gga246fde0e79029f514ce3846b31e366d7a6f0f4df45e9cac012a2c8e5ba736241b"></a>CYHAL_POWER_LEVEL_DEFAULT&#160;</td><td class="fielddoc"><p >Default comparator power and speed. </p>
</td></tr>
</table>

</div>
</div>
<a id="ga801c21c8f1d529c8d189990ce6825080" name="ga801c21c8f1d529c8d189990ce6825080"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga801c21c8f1d529c8d189990ce6825080">&#9670;&nbsp;</a></span>cyhal_signal_type_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__hal__general__types.html#ga801c21c8f1d529c8d189990ce6825080">cyhal_signal_type_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Signal trigger type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga801c21c8f1d529c8d189990ce6825080aa9353d53eb66a3c2e9ebdddf5d0a2592" name="gga801c21c8f1d529c8d189990ce6825080aa9353d53eb66a3c2e9ebdddf5d0a2592"></a>CYHAL_SIGNAL_TYPE_LEVEL&#160;</td><td class="fielddoc"><p >Level triggered. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga801c21c8f1d529c8d189990ce6825080a58d09b40c703bb1d09ac9d635c096cd9" name="gga801c21c8f1d529c8d189990ce6825080a58d09b40c703bb1d09ac9d635c096cd9"></a>CYHAL_SIGNAL_TYPE_EDGE&#160;</td><td class="fielddoc"><p >Edge triggered. </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Hardware Abstraction Layer (HAL)</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
